<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.connections.html">connections()</a></code>
</p>
<p class="firstline">Returns the connections Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.customConnectors.html">customConnectors()</a></code>
</p>
<p class="firstline">Returns the customConnectors Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.endpointAttachments.html">endpointAttachments()</a></code>
</p>
<p class="firstline">Returns the endpointAttachments Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.global_.html">global_()</a></code>
</p>
<p class="firstline">Returns the global_ Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.providers.html">providers()</a></code>
</p>
<p class="firstline">Returns the providers Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
  <code><a href="#getRegionalSettings">getRegionalSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">GetRegionalSettings gets settings of a region. RegionalSettings is a singleton resource.</p>
<p class="toc_element">
  <code><a href="#getRuntimeConfig">getRuntimeConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.</p>
<p class="toc_element">
  <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#updateRegionalSettings">updateRegionalSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the settings of a region.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets information about a location.

Args:
  name: string, Resource name for the location. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that represents a Google Cloud location.
  &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
  &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
  &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
}</pre>
</div>

<div class="method">
    <code class="details" id="getRegionalSettings">getRegionalSettings(name, x__xgafv=None)</code>
  <pre>GetRegionalSettings gets settings of a region. RegionalSettings is a singleton resource.

Args:
  name: string, Required. The resource name of the Regional Settings. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Regional Settings details.
  &quot;encryptionConfig&quot;: { # Regional encryption config for CMEK details. # Optional. Regional encryption config to hold CMEK details.
    &quot;encryptionType&quot;: &quot;A String&quot;, # Optional. Encryption type for the region.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings
  &quot;networkConfig&quot;: { # Regional Network Config. # Optional. Regional network config.
    &quot;egressIps&quot;: [ # Output only. Egress IPs
      &quot;A String&quot;,
    ],
    &quot;egressMode&quot;: &quot;A String&quot;, # Optional. Egress mode for the network.
  },
  &quot;provisioned&quot;: True or False, # Output only. Specifies whether the region is provisioned.
}</pre>
</div>

<div class="method">
    <code class="details" id="getRuntimeConfig">getRuntimeConfig(name, x__xgafv=None)</code>
  <pre>Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/runtimeConfig` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RuntimeConfig is the singleton resource of each location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage location storing schema etc.
  &quot;conndSubscription&quot;: &quot;A String&quot;, # Output only. Pub/Sub subscription for connd to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
  &quot;conndTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic for connd to send message. E.g. projects/{project-id}/topics/{topic-id}
  &quot;controlPlaneSubscription&quot;: &quot;A String&quot;, # Output only. Pub/Sub subscription for control plane to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
  &quot;controlPlaneTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic for control plne to send message. communication. E.g. projects/{project-id}/topics/{topic-id}
  &quot;locationId&quot;: &quot;A String&quot;, # Output only. location_id of the runtime location. E.g. &quot;us-west1&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the runtimeConfig resource. Format: projects/{project}/locations/{location}/runtimeConfig
  &quot;runtimeEndpoint&quot;: &quot;A String&quot;, # Output only. The endpoint of the connectors runtime ingress.
  &quot;schemaGcsBucket&quot;: &quot;A String&quot;, # Output only. The Cloud Storage bucket that stores connector&#x27;s schema reports.
  &quot;serviceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service name.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the location.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists information about the supported locations for this service.

Args:
  name: string, The resource that owns the locations collection, if applicable. (required)
  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don&#x27;t use this unsupported field which is primarily intended for internal usage. (repeated)
  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Locations.ListLocations.
  &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
    { # A resource that represents a Google Cloud location.
      &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
      &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
      &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
      &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="updateRegionalSettings">updateRegionalSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update the settings of a region.

Args:
  name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings (required)
  body: object, The request body.
    The object takes the form of:

{ # Regional Settings details.
  &quot;encryptionConfig&quot;: { # Regional encryption config for CMEK details. # Optional. Regional encryption config to hold CMEK details.
    &quot;encryptionType&quot;: &quot;A String&quot;, # Optional. Encryption type for the region.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings
  &quot;networkConfig&quot;: { # Regional Network Config. # Optional. Regional network config.
    &quot;egressIps&quot;: [ # Output only. Egress IPs
      &quot;A String&quot;,
    ],
    &quot;egressMode&quot;: &quot;A String&quot;, # Optional. Egress mode for the network.
  },
  &quot;provisioned&quot;: True or False, # Output only. Specifies whether the region is provisioned.
}

  updateMask: string, Required. The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>